Updated method for identifying devices by IPv4 address #139

eric-murray · 2023-04-20T11:39:07Z

What type of PR is this?

enhancement/feature
documentation

What this PR does / why we need it:

This PR introduces the new schema DeviceIpv4Addr, which is used for the ipv4Address property of the Device object. The DeviceIpv4Addr object allows the device to be identified by a combination of its public IPv4 address (publicAddress) and at least one of either its public port (publicPort) or private (device local) IPv4 address (privateAddress).

This modified schema is required to support the scenario where it is desired to identify the device by its private (local) IPv4 address, as this alone is generally insufficient to identify the device, and the public (NATed) IPv4 address must also be provided.

Which issue(s) this PR fixes:

Fixes #34 : Resolving ueAddr ambiguity when it is the UE private address

Special notes for reviewers:

For NAT64 scenarios, it has been confirmed that the device IPv6 address alone is sufficient to identify it, and hence this PR does not affect those scenarios
Flow rules are unaffected by this PR, with the exception that IPv4 subnets can no longer be specified for the device. If publicPort is specified to identify the device, this value is not used for flow rules. Description of devicePorts has been added to clarify that these are the local ports used directly by the device for flow rules.

Changelog input

Updated qod-api.yaml
- Schema objects DeviceIpv4Addr and SingleIpv4Addr defined
- Device property ipv4Address now of type DeviceIpv4Addr
- Updated error message definitions
- Minor format changes

Updated documentation QoD_API.md

- Schema objects DeviceIpv4Addr and SingleIpv4Addr defined - Device property ipv4Address now of type DeviceIpv4Addr - CreateSession property devicePorts renamed deviceAllocatedPorts - Updated error message definitions - Minor format changes

Fix error message InvalidDevicePublicPortValue

Updated documentation for change in identifying devices by IPv4 address

Fixed error table numbering

code/API_definitions/qod-api.yaml

Co-authored-by: Jose Luis Urien <[email protected]>

emil-cheung · 2023-04-23T03:24:01Z

@hdamker ,
please help to arrange a community voting for:

Observed IP address/Local IP address vs. Public IP address/Private IP address

eric-murray · 2023-04-23T22:00:58Z

@emil-cheung
I had put some suggestions in the issue, but we can refine them here. Do you still want assigned to be considered as was proposed here? If not, then I think we have the following options:

Vote 1: `DeviceIpv4Addr` object properties

Option 1 : publicAddress, privateAddress & publicPort
Option 2: observedAddress, localAddress & observedPort

Vote 2: Rename of `devicePorts` property of `CreateSession` object

Option 1 : deviceLocalPorts
Option 2 : deviceSourcePorts

emil-cheung · 2023-04-24T03:44:53Z

@emil-cheung I had put some suggestions in the issue, but we can refine them here. Do you still want assigned to be considered as was proposed here? If not, then I think we have the following options:

Vote 1: DeviceIpv4Addr object properties

Option 1 : publicAddress, privateAddress & publicPort Option 2: observedAddress, localAddress & observedPort

Vote 2: Rename of devicePorts property of CreateSession object

Option 1 : deviceLocalPorts Option 2 : deviceSourcePorts

Yes, we prefer 'local' instead of 'assigned'.

Replace oneOf with anyOf in DeviceIpv4Addr

hdamker · 2023-04-27T20:39:41Z

@eric-murray As already written in the issues:

Votes are created and open until next Thursday, May 4th, 12:00 UTC:

- reverted deviceAllocatedPorts to devicePorts, but added description of modified usage - removed `format: ipv4` from SingleIpv4Addr

- Update documentation for devicePorts

- Fix InvalidDevicePortsRanges error decription

- Fix error camaraproject#9 description

- Fix CannotIdentifyDevice error

eric-murray · 2023-05-05T15:48:05Z

Ready for final review now

code/API_definitions/qod-api.yaml

- Renamed InsufficientProperties to InsufficientDeviceProperties - Renamed InconsistentProperties to InconsistentDeviceProperties - Fixed typo in PhoneNumber object description

sfnuser

Looks good to me.

documentation/API_documentation/QoD_API.md

Co-authored-by: Ramesh Shanmugasundaram - Spry Fox Networks <[email protected]>

jlurien · 2023-05-12T15:55:38Z

@hdamker I see that there will be a a lot of conflicts between this PR and the pending one I have to incorporate and update doc within spec, so I will wait to have this merged. If done in the next days I will submit mine before next meeting.

hdamker · 2023-05-16T19:00:38Z

Seems that we are good to go ... 3+ final reviews and 4 days no new comments.

eric-murray added 7 commits April 19, 2023 23:40

Update qod-api.yaml

898362c

Update qod-api.yaml

0968d79

Update qod-api.yaml

d539627

Update qod-api.yaml

286c5b0

- Schema objects DeviceIpv4Addr and SingleIpv4Addr defined - Device property ipv4Address now of type DeviceIpv4Addr - CreateSession property devicePorts renamed deviceAllocatedPorts - Updated error message definitions - Minor format changes

Update qod-api.yaml

0ae46ba

Fix error message InvalidDevicePublicPortValue

Update QoD_API.md

cced452

Updated documentation for change in identifying devices by IPv4 address

Update QoD_API.md

510ebd8

Fixed error table numbering

eric-murray requested review from hdamker and shilpa-padgaonkar as code owners April 20, 2023 11:39

eric-murray mentioned this pull request Apr 20, 2023

Resolving ueAddr ambiguity when it is the UE private address #34

Closed

jlurien reviewed Apr 21, 2023

View reviewed changes

code/API_definitions/qod-api.yaml Outdated Show resolved Hide resolved

code/API_definitions/qod-api.yaml Outdated Show resolved Hide resolved

code/API_definitions/qod-api.yaml Outdated Show resolved Hide resolved

Update code/API_definitions/qod-api.yaml

a48d615

Co-authored-by: Jose Luis Urien <[email protected]>

Update qod-api.yaml

3882c44

Replace oneOf with anyOf in DeviceIpv4Addr

eric-murray added 6 commits May 5, 2023 15:58

Merge branch 'camaraproject:main' into main

5b76e26

Update qod-api.yaml

6c53620

- reverted deviceAllocatedPorts to devicePorts, but added description of modified usage - removed `format: ipv4` from SingleIpv4Addr

Update QoD_API.md

a011dea

- Update documentation for devicePorts

Update qod-api.yaml

f76b89c

- Fix InvalidDevicePortsRanges error decription

Update QoD_API.md

3a7027a

- Fix error camaraproject#9 description

Update qod-api.yaml

0525029

- Fix CannotIdentifyDevice error

hdamker requested review from patrice-conil, akoshunyadi, emil-cheung and sfnuser May 8, 2023 07:18

akoshunyadi reviewed May 8, 2023

View reviewed changes

code/API_definitions/qod-api.yaml Outdated Show resolved Hide resolved

code/API_definitions/qod-api.yaml Outdated Show resolved Hide resolved

code/API_definitions/qod-api.yaml Outdated Show resolved Hide resolved

Update qod-api.yaml

a210979

- Renamed InsufficientProperties to InsufficientDeviceProperties - Renamed InconsistentProperties to InconsistentDeviceProperties - Fixed typo in PhoneNumber object description

sfnuser reviewed May 11, 2023

View reviewed changes

documentation/API_documentation/QoD_API.md Outdated Show resolved Hide resolved

Update documentation/API_documentation/QoD_API.md

2ff4b60

Co-authored-by: Ramesh Shanmugasundaram - Spry Fox Networks <[email protected]>

sfnuser approved these changes May 11, 2023

View reviewed changes

jlurien approved these changes May 12, 2023

View reviewed changes

hdamker approved these changes May 16, 2023

View reviewed changes

hdamker merged commit 8e0d2ea into camaraproject:main May 16, 2023

hdamker mentioned this pull request Jun 17, 2023

Pre release v0.9.0 rc #169

Merged

eric-murray mentioned this pull request Aug 10, 2023

Include support for /PATCH sessions #47

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated method for identifying devices by IPv4 address #139

Updated method for identifying devices by IPv4 address #139

eric-murray commented Apr 20, 2023 •

edited

Loading

emil-cheung commented Apr 23, 2023

eric-murray commented Apr 23, 2023

emil-cheung commented Apr 24, 2023

Vote 1: `DeviceIpv4Addr` object properties

Vote 2: Rename of `devicePorts` property of `CreateSession` object

hdamker commented Apr 27, 2023

eric-murray commented May 5, 2023

sfnuser left a comment

jlurien commented May 12, 2023

hdamker commented May 16, 2023

Updated method for identifying devices by IPv4 address #139

Updated method for identifying devices by IPv4 address #139

Conversation

eric-murray commented Apr 20, 2023 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for reviewers:

Changelog input

emil-cheung commented Apr 23, 2023

eric-murray commented Apr 23, 2023

Vote 1: DeviceIpv4Addr object properties

Vote 2: Rename of devicePorts property of CreateSession object

emil-cheung commented Apr 24, 2023

Vote 1: DeviceIpv4Addr object properties

Vote 2: Rename of devicePorts property of CreateSession object

hdamker commented Apr 27, 2023

eric-murray commented May 5, 2023

sfnuser left a comment

Choose a reason for hiding this comment

jlurien commented May 12, 2023

hdamker commented May 16, 2023

eric-murray commented Apr 20, 2023 •

edited

Loading

Vote 1: `DeviceIpv4Addr` object properties

Vote 2: Rename of `devicePorts` property of `CreateSession` object

Vote 1: `DeviceIpv4Addr` object properties

Vote 2: Rename of `devicePorts` property of `CreateSession` object